Inscoper::SequenceHandler

SequenceHandler class manages sequence preparation progress and cancellation. More...

#include <SequenceHandler.h>

Public Functions

	Name
	SequenceHandler(unsigned long long int interval =1000000) Constructor with interval.
virtual	~SequenceHandler() Virtual destructor.
virtual void	onProgress(ESequencePreparationStatus status, float progress) =0 Progress notification.
void	cancelPreparation() Cancel preparation.
bool	isCancelled() const Check if cancelled.
void	setInterval(unsigned long long int interval) Set notification interval.
unsigned long long int	getInterval() Get notification interval.

Detailed Description

class Inscoper::SequenceHandler;

SequenceHandler class manages sequence preparation progress and cancellation.

This abstract class provides a mechanism for users to be notified of preparation progress (0.0 to 1.0) and to request cancellation of the process.

Public Functions Documentation

function SequenceHandler

explicit SequenceHandler(
    unsigned long long int interval =1000000
)

Constructor with interval.

Parameters:

• interval : Interval between two notifications in microseconds (default: 1,000,000 us = 1s)

Initializes a new instance of the SequenceHandler class.

function ~SequenceHandler

inline virtual ~SequenceHandler()

Virtual destructor.

function onProgress

virtual void onProgress(
    ESequencePreparationStatus status,
    float progress
) =0

Progress notification.

Parameters:

• status : The current preparation status
• progress : The preparation progress (0.0 to 1.0)

This callback method is invoked at each time interval to report the current status and progress of the preparation. Must be overridden.

function cancelPreparation

void cancelPreparation()

Cancel preparation.

Requests the cancellation of the current sequence preparation.

function isCancelled

bool isCancelled() const

Check if cancelled.

Return: True if cancellation has been requested, false otherwise

Checks whether a cancellation request has been issued.

function setInterval

void setInterval(
    unsigned long long int interval
)

Set notification interval.

Parameters:

• interval : The interval in microseconds

Sets the time interval between consecutive progress notifications.

function getInterval

unsigned long long int getInterval()

Get notification interval.

Return: The interval in microseconds

Retrieves the current time interval between progress notifications.

---

Updated on 2026-04-02 at 10:55:36 +0200